Usage Requirements

AssetWise Template Definitions

Upon installation, the following Document templates will be created and are used to move data back and forth between the user and the Import/Export engine regarding Comments Tracking:

Property	Description
EB_COMMENTSTRACKING_MAP_TEMPLATE	Contains the Mapping (or Provisioning) file that is required by the engine. To configure the system, create an instance of this template and upload the provisioning file that will be used for import/export Important: This document is required before any Import/Export operation executes and must be configured by the administrator. (Create an instance of the document and upload the comments tracking provisioning xml file to it)
EB_COMMENTSTRACKING_TMP_TEMPLATE	Contains the "Export Output Template file". This template is an Excel spreadsheet to which output from the export will be appended. To configure the system, create an instance of this template and upload the Excel template spreadsheet that will be used (Bentley Commenting Template - Response Phase.xlsx) . Note: This document should be configured by the administrator. (Create an instance of the document and upload the xlsx file to it.)
EB_COMMENTSTRACKING_EMAIL_TMP_TEMPLATE	Contains the "Import/Export email Template file". The template file is an xml file containing the email definitions that are used if emails are to be sent upon completion of the import/export job. To configure the system, create an instance of this template and then upload the xml template that will be used (emailTemplate.xml). This template is an Excel file containing a single sheet with instructions for the exported data. Note: This document should be configured by the administrator. (Create an instance of the document and upload the xml file to it.)
EB_COMMENTSTRACKING_PKG_TEMPLATE	Contains the results from the export. To have the ability to email within AssetWise, files must be stored in a "container". This document represents that container. When doing an export, the caller must create an instance of this template, which is then populated with the results from the operation. These documents will be instantiated by the caller (AssetWise).

Files

To fulfill the usage needs for the Templates, the following files are used by the Import/Export engine for Comments Tracking:

File	Description
comments_tracking.xml	This file is the file that gets inserted into the instantiated EB_COMMENTSTRACKING_MAP_TEMPLATE document. It contains the mapping definitions between the AssetWise objects, the output spreadsheet, and the query columns returned from the ebp_get_comments_tacking procedures.
Response_Phase.xlsx	This is the Bentley Commenting template. This file gets inserted into the instantiated EB_COMMENTSTRACKING_TMP_TEMPLATE document. It contains the Instructions sheet that gets preceded to any output from Export.
emailTemplate.xml	This file gets inserted into the instantiated EB_COMMENTSTRACKING_EMAIL_TMP_TEMPLATE document. It contains the xml definitions for the email (subject, body, etc.) that gets sent based on the operation and success of that operation.

Exporting Comments

The export operation will be run through the engine interface in AssetWise. This is accomplished by setting up the required properties and then submitting the job to AssetWise so that it can go into the queue for processing. When submitting a job for Export, the following properties must be set on the Engine request:

Property	Description
job_id	The job name. This property is mandatory.
dest_doc_id	The Document Id of the EB_COMMENTSTRACKING_PKG_TEMPLATE where the results of the operation are placed. This property is mandatory.
mapping_file_id	The File Id of the xml mapping/provisioning file contained within the EB_COMMENTSTRACKING_MAP_TEMPLATE that has been chosen to use for the operation. This property is mandatory.
template_file_id	The File Id of the xlsx template file contained in the EB_COMMENTSTRACKING_TMP_TEMPLATE that has been chosen to use for the operation.
email_template_file_id	The File Id of the xml email template file contained in the EB_COMMENTSTRACKING_EMAIL_TMP_TEMPLATE that has been chosen to use for the operation.
document_list	A comma-delimited string, for example ,"1,2,3", of Document Ids from which the associated comments are exported.
file_name	The destination xlsx filename for the exported sheet that is placed into the dest_doc_id property.

Upon completion of Export, the engine emails the resulting data file and logs, (in addition to placing those results in the destination document), to the user who submitted the job.

Importing Comments

The import operation will be run through the engine interface in AssetWise. This is accomplished by setting up the required properties and then submitting the job to AssetWise so that it can go into the queue for processing. When submitting a job for Import, the following properties must be set on the Engine request:

Property	Description
job_id	The job name. This property is mandatory.
data_file_id	The File Id of the data that has been uploaded into AssetWise that is to be imported. This is the Excel spreadsheet that contains the comments. This property is mandatory.
mapping_file_id	The File Id of the xml mapping/provisioning file contained within the EB_COMMENTSTRACKING_MAP_TEMPLATE that has been chosen to use for the operation. This property is mandatory.
record_and_play	A boolean value that tells the engine whether to operate in "Record and Play" mode instead of "Direct" mode in terms of database transactions. If this value is not present, the default value "TRUE" is used and should be sufficient.
email_template_file_id	The File Id of the xml email template file contained in the EB_COMMENTSTRACKING_EMAIL_TMP_TEMPLATE that has been chosen to use for the operation.
document_list	A comma-delimited string, for example, "1,2,3", of Document Ids from which the associated comments are imported.
parameters	A list of parameter names and values that are to be injected into the operation. The following values are used: personId – The Id of the person to associate with the Comments that are being created, modified, or deleted. This represents the Id of the caller, but can be used to allow the ability to use different Ids if needed. priorityCode – The Code of the priority to associate with the Comments that are being created, modified, or deleted. The following is an example of the format: "personId:123;priorityCode:Default Comment Import"

Upon completion of Import, the engine emails the resulting log file to the user who submitted the job.